<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Bluetooth Host Stack Library: GATT Server Data API</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Bluetooth Host Stack Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__gattsr__api__functions.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">GATT Server Data API<div class="ingroups"><a class="el" href="group__wicedbt__gatt.html">Generic Attribute (GATT)</a> &raquo; <a class="el" href="group__gatt__server__api__functions.html">Server API</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>GATT Server Data API. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga0cb76e23dcabd30c6fbe2e8139f96ad9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__wicedbt__gatt.html#ga0e035835afe92d61fe430ea19029677a">wiced_bt_gatt_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gattsr__api__functions.html#ga0cb76e23dcabd30c6fbe2e8139f96ad9">wiced_bt_gatt_server_send_indication</a> (uint16_t conn_id, uint16_t attr_handle, uint16_t val_len, uint8_t *p_app_buffer, <a class="el" href="group__wicedbt__gatt.html#ga80c3de8e66dd4257528aeaf34484d14c">wiced_bt_gatt_app_context_t</a> p_app_ctxt)</td></tr>
<tr class="memdesc:ga0cb76e23dcabd30c6fbe2e8139f96ad9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API will send a long (1 upto (MTU -3) bytes) indication to the client for the specified handle with a persistent buffer in <code>p_app_buffer</code>.  <a href="#ga0cb76e23dcabd30c6fbe2e8139f96ad9">More...</a><br /></td></tr>
<tr class="separator:ga0cb76e23dcabd30c6fbe2e8139f96ad9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae6b81296d8e3deebefdab879b874439e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__wicedbt__gatt.html#ga0e035835afe92d61fe430ea19029677a">wiced_bt_gatt_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gattsr__api__functions.html#gae6b81296d8e3deebefdab879b874439e">wiced_bt_gatt_server_send_notification</a> (uint16_t conn_id, uint16_t attr_handle, uint16_t val_len, uint8_t *p_app_buffer, <a class="el" href="group__wicedbt__gatt.html#ga80c3de8e66dd4257528aeaf34484d14c">wiced_bt_gatt_app_context_t</a> p_app_ctxt)</td></tr>
<tr class="memdesc:gae6b81296d8e3deebefdab879b874439e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API will send a long (1 upto (MTU -3) bytes) notification to the client for the specified handle with a persistent buffer in <code>p_app_buffer</code>.  <a href="#gae6b81296d8e3deebefdab879b874439e">More...</a><br /></td></tr>
<tr class="separator:gae6b81296d8e3deebefdab879b874439e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab222ca3f30e05cab6168f2755b838035"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__wicedbt__gatt.html#ga0e035835afe92d61fe430ea19029677a">wiced_bt_gatt_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gattsr__api__functions.html#gab222ca3f30e05cab6168f2755b838035">wiced_bt_gatt_server_send_multiple_notifications</a> (uint16_t conn_id, uint16_t app_buffer_len, uint8_t *p_app_buffer, <a class="el" href="group__wicedbt__gatt.html#ga80c3de8e66dd4257528aeaf34484d14c">wiced_bt_gatt_app_context_t</a> p_app_ctxt)</td></tr>
<tr class="memdesc:gab222ca3f30e05cab6168f2755b838035"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API will send a long (1 upto (MTU -1) bytes) multiple variable length notification to the client with a persistent buffer in <code>p_app_buffer</code>.  <a href="#gab222ca3f30e05cab6168f2755b838035">More...</a><br /></td></tr>
<tr class="separator:gab222ca3f30e05cab6168f2755b838035"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga0cb76e23dcabd30c6fbe2e8139f96ad9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0cb76e23dcabd30c6fbe2e8139f96ad9">&#9670;&nbsp;</a></span>wiced_bt_gatt_server_send_indication()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__wicedbt__gatt.html#ga0e035835afe92d61fe430ea19029677a">wiced_bt_gatt_status_t</a> wiced_bt_gatt_server_send_indication </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>conn_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>attr_handle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>val_len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>p_app_buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__wicedbt__gatt.html#ga80c3de8e66dd4257528aeaf34484d14c">wiced_bt_gatt_app_context_t</a>&#160;</td>
          <td class="paramname"><em>p_app_ctxt</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This API will send a long (1 upto (MTU -3) bytes) indication to the client for the specified handle with a persistent buffer in <code>p_app_buffer</code>. </p>
<p>The indication confirmation from the remote is indicated by an GATT_ATTRIBUTE_REQUEST_EVT with <a class="el" href="structwiced__bt__gatt__attribute__request__t.html#a0afffdd0df923ead9fe51276cdfc94a8" title="GATT request opcode.">wiced_bt_gatt_attribute_request_t.opcode</a> = GATT_HANDLE_VALUE_IND</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">conn_id</td><td>: connection identifier. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">attr_handle</td><td>: Attribute handle of this handle value indication. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">val_len</td><td>: Length of indication value passed. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">p_app_buffer</td><td>: Indication Value, peristent till the data is sent out to the controller </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">p_app_ctxt</td><td>: Application context for <code>p_app_buffer</code> </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The application may free/release/deallocate the <code>p_app_buffer</code> pointer on receiving a <a class="el" href="group__wicedbt__gatt.html#gga1a4943c0f32914d5d939b05e84c99631a68a87f3f6a4f7c061b50872522f507a4">GATT_APP_BUFFER_TRANSMITTED_EVT</a> with <a class="el" href="structwiced__bt__gatt__buffer__transmitted__t.html#a9dc2ce0fcd9d8fdce23345249c36a42e">wiced_bt_gatt_buffer_transmitted_t::p_app_data</a> = <code>p_app_buffer</code> and <a class="el" href="structwiced__bt__gatt__buffer__transmitted__t.html#aee4534bcf5ed42ab50f7c80a46278a1a">wiced_bt_gatt_buffer_transmitted_t::p_app_ctxt</a> = <code>p_app_ctxt</code> </dd></dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__wicedbt__gatt.html#ga972f2437538363989cee28019cb06652">wiced_bt_gatt_status_t </a> </dd></dl>

</div>
</div>
<a id="gae6b81296d8e3deebefdab879b874439e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae6b81296d8e3deebefdab879b874439e">&#9670;&nbsp;</a></span>wiced_bt_gatt_server_send_notification()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__wicedbt__gatt.html#ga0e035835afe92d61fe430ea19029677a">wiced_bt_gatt_status_t</a> wiced_bt_gatt_server_send_notification </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>conn_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>attr_handle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>val_len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>p_app_buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__wicedbt__gatt.html#ga80c3de8e66dd4257528aeaf34484d14c">wiced_bt_gatt_app_context_t</a>&#160;</td>
          <td class="paramname"><em>p_app_ctxt</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This API will send a long (1 upto (MTU -3) bytes) notification to the client for the specified handle with a persistent buffer in <code>p_app_buffer</code>. </p>
<p>The send complete of the notification is indicated by an GATT_ATTRIBUTE_REQUEST_EVT with <a class="el" href="structwiced__bt__gatt__attribute__request__t.html#a0afffdd0df923ead9fe51276cdfc94a8" title="GATT request opcode.">wiced_bt_gatt_attribute_request_t.opcode</a> = GATT_HANDLE_VALUE_NOTIF</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">conn_id</td><td>: connection identifier. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">attr_handle</td><td>: Attribute handle of this handle value notification. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">val_len</td><td>: Length of notification value passed. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">p_app_buffer</td><td>: Notification Value, peristent till the data is sent out to the controller </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">p_app_ctxt</td><td>: Application context for <code>p_app_buffer</code> </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The application may free/release/deallocate the <code>p_app_buffer</code> pointer on receiving a <a class="el" href="group__wicedbt__gatt.html#gga1a4943c0f32914d5d939b05e84c99631a68a87f3f6a4f7c061b50872522f507a4">GATT_APP_BUFFER_TRANSMITTED_EVT</a> with <a class="el" href="structwiced__bt__gatt__buffer__transmitted__t.html#a9dc2ce0fcd9d8fdce23345249c36a42e">wiced_bt_gatt_buffer_transmitted_t::p_app_data</a> = <code>p_app_buffer</code> and <a class="el" href="structwiced__bt__gatt__buffer__transmitted__t.html#aee4534bcf5ed42ab50f7c80a46278a1a">wiced_bt_gatt_buffer_transmitted_t::p_app_ctxt</a> = <code>p_app_ctxt</code> </dd></dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__wicedbt__gatt.html#ga972f2437538363989cee28019cb06652">wiced_bt_gatt_status_t </a> </dd></dl>

</div>
</div>
<a id="gab222ca3f30e05cab6168f2755b838035"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab222ca3f30e05cab6168f2755b838035">&#9670;&nbsp;</a></span>wiced_bt_gatt_server_send_multiple_notifications()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__wicedbt__gatt.html#ga0e035835afe92d61fe430ea19029677a">wiced_bt_gatt_status_t</a> wiced_bt_gatt_server_send_multiple_notifications </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>conn_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>app_buffer_len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>p_app_buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__wicedbt__gatt.html#ga80c3de8e66dd4257528aeaf34484d14c">wiced_bt_gatt_app_context_t</a>&#160;</td>
          <td class="paramname"><em>p_app_ctxt</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This API will send a long (1 upto (MTU -1) bytes) multiple variable length notification to the client with a persistent buffer in <code>p_app_buffer</code>. </p>
<p>The send complete of the notification is indicated by an GATT_ATTRIBUTE_REQUEST_EVT with <a class="el" href="structwiced__bt__gatt__attribute__request__t.html#a0afffdd0df923ead9fe51276cdfc94a8" title="GATT request opcode.">wiced_bt_gatt_attribute_request_t.opcode</a> = GATT_HANDLE_VALUE_MULTI_NOTIF</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">conn_id</td><td>: connection identifier. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">app_buffer_len</td><td>: Length of multiple notification values passed, should not exceed MTU - 1. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">p_app_buffer</td><td>: Notification Values, peristent till the data is sent out to the controller </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>: Notification values are formatted by the application by setting the handle(2 octets LE), len(2 octets LE) and data of handle of length for atleast 2 handle, len, data pairs. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">p_app_ctxt</td><td>: Application context for <code>p_app_buffer</code> </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The application may free/release/deallocate the <code>p_app_buffer</code> pointer on receiving a <a class="el" href="group__wicedbt__gatt.html#gga1a4943c0f32914d5d939b05e84c99631a68a87f3f6a4f7c061b50872522f507a4">GATT_APP_BUFFER_TRANSMITTED_EVT</a> with <a class="el" href="structwiced__bt__gatt__buffer__transmitted__t.html#a9dc2ce0fcd9d8fdce23345249c36a42e">wiced_bt_gatt_buffer_transmitted_t::p_app_data</a> = <code>p_app_buffer</code> and <a class="el" href="structwiced__bt__gatt__buffer__transmitted__t.html#aee4534bcf5ed42ab50f7c80a46278a1a">wiced_bt_gatt_buffer_transmitted_t::p_app_ctxt</a> = <code>p_app_ctxt</code> </dd></dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__wicedbt__gatt.html#ga972f2437538363989cee28019cb06652">wiced_bt_gatt_status_t </a> </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Bluetooth Host Stack Library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
</body>
</html>
